<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <!-- For Mobile Devices -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta name="generator" content="Doxygen 1.8.18"/>
        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
        <title>HElib: helib::PAlgebraModBase Class Reference</title>
        <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
        <script type="text/javascript" src="dynsections.js"></script>
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
        <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
		<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100;1,700&family=Merriweather&family=Merriweather+Sans&family=Open+Sans&family=Poppins:ital@1&family=Roboto:ital,wght@0,400;1,300;1,900&display=swap" rel="stylesheet"> 
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
        <link href="jquery.smartmenus.bootstrap.css" rel="stylesheet">
        <script type="text/javascript" src="jquery.smartmenus.js"></script>
        <!-- SmartMenus jQuery Bootstrap Addon -->
        <script type="text/javascript" src="jquery.smartmenus.bootstrap.js"></script>
        <!-- SmartMenus jQuery plugin -->
    </head>
    <body style="font-family: 'Merriweather', serif;">
        <nav class="navbar navbar-default" role="navigation">
            <div class="container">
                <div class="navbar-header">
                    <a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
                </div>
            </div>
        </nav>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
                <div class="container">
                    <div class="row">
                        <div class="col-sm-12 panel " style="padding-bottom: 15px;">
                            <div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacehelib.html">helib</a></li><li class="navelem"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html">PAlgebraModBase</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classhelib_1_1_p_algebra_mod_base-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">helib::PAlgebraModBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Virtual base class for <a class="el" href="classhelib_1_1_p_algebra_mod.html" title="The structure of Z[X]/(Phi_m(X), p)">PAlgebraMod</a>.  
 <a href="classhelib_1_1_p_algebra_mod_base.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_p_algebra_8h_source.html">PAlgebra.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for helib::PAlgebraModBase:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classhelib_1_1_p_algebra_mod_base.png" usemap="#helib::PAlgebraModBase_map" alt=""/>
  <map id="helib::PAlgebraModBase_map" name="helib::PAlgebraModBase_map">
<area href="classhelib_1_1_p_algebra_mod_cx.html" alt="helib::PAlgebraModCx" shape="rect" coords="0,56,151,80"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a98ba2824e68366e7266717ff9f077334"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a98ba2824e68366e7266717ff9f077334">~PAlgebraModBase</a> ()</td></tr>
<tr class="separator:a98ba2824e68366e7266717ff9f077334"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11f446121f3f4e99004ac5f63cd9222d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classhelib_1_1_p_algebra_mod_base.html">PAlgebraModBase</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a11f446121f3f4e99004ac5f63cd9222d">clone</a> () const =0</td></tr>
<tr class="separator:a11f446121f3f4e99004ac5f63cd9222d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8df7e36de931c1365efc1a1ec9ef0a59"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacehelib.html#ab0181d82dc81ed4d1f8c1d950b4efd7e">PA_tag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a8df7e36de931c1365efc1a1ec9ef0a59">getTag</a> () const =0</td></tr>
<tr class="memdesc:a8df7e36de931c1365efc1a1ec9ef0a59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type tag: PA_GF2_tag or PA_zz_p_tag.  <a href="classhelib_1_1_p_algebra_mod_base.html#a8df7e36de931c1365efc1a1ec9ef0a59">More...</a><br /></td></tr>
<tr class="separator:a8df7e36de931c1365efc1a1ec9ef0a59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bcc03053392d25c4a8d1c3eb36107e1"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classhelib_1_1_p_algebra.html">PAlgebra</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a7bcc03053392d25c4a8d1c3eb36107e1">getZMStar</a> () const =0</td></tr>
<tr class="memdesc:a7bcc03053392d25c4a8d1c3eb36107e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns reference to underlying <a class="el" href="classhelib_1_1_p_algebra.html" title="The structure of (Z/mZ)* /(p)">PAlgebra</a> object.  <a href="classhelib_1_1_p_algebra_mod_base.html#a7bcc03053392d25c4a8d1c3eb36107e1">More...</a><br /></td></tr>
<tr class="separator:a7bcc03053392d25c4a8d1c3eb36107e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9aa0cf6f8db16b0eaad3f2d4362a37c"><td class="memItemLeft" align="right" valign="top">virtual const std::vector&lt; NTL::ZZX &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#ae9aa0cf6f8db16b0eaad3f2d4362a37c">getFactorsOverZZ</a> () const =0</td></tr>
<tr class="memdesc:ae9aa0cf6f8db16b0eaad3f2d4362a37c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns reference to the factorization of Phi_m(X) mod p^r, but as ZZX's.  <a href="classhelib_1_1_p_algebra_mod_base.html#ae9aa0cf6f8db16b0eaad3f2d4362a37c">More...</a><br /></td></tr>
<tr class="separator:ae9aa0cf6f8db16b0eaad3f2d4362a37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adead1be06feaba45fa7dab3a34b856a3"><td class="memItemLeft" align="right" valign="top">virtual long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#adead1be06feaba45fa7dab3a34b856a3">getR</a> () const =0</td></tr>
<tr class="memdesc:adead1be06feaba45fa7dab3a34b856a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value r.  <a href="classhelib_1_1_p_algebra_mod_base.html#adead1be06feaba45fa7dab3a34b856a3">More...</a><br /></td></tr>
<tr class="separator:adead1be06feaba45fa7dab3a34b856a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a909cc316ce549f517857b17c172aae7b"><td class="memItemLeft" align="right" valign="top">virtual long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a909cc316ce549f517857b17c172aae7b">getPPowR</a> () const =0</td></tr>
<tr class="memdesc:a909cc316ce549f517857b17c172aae7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value p^r.  <a href="classhelib_1_1_p_algebra_mod_base.html#a909cc316ce549f517857b17c172aae7b">More...</a><br /></td></tr>
<tr class="separator:a909cc316ce549f517857b17c172aae7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87de36ed5995b6baf94954b6810b9130"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a87de36ed5995b6baf94954b6810b9130">restoreContext</a> () const =0</td></tr>
<tr class="memdesc:a87de36ed5995b6baf94954b6810b9130"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores the <a class="el" href="namespace_n_t_l.html">NTL</a> context for p^r.  <a href="classhelib_1_1_p_algebra_mod_base.html#a87de36ed5995b6baf94954b6810b9130">More...</a><br /></td></tr>
<tr class="separator:a87de36ed5995b6baf94954b6810b9130"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61bf1413f4b2e9050d83915984036bc6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacehelib.html#a4d6002f36f1a61982fded09adf1331ca">zzX</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_p_algebra_mod_base.html#a61bf1413f4b2e9050d83915984036bc6">getMask_zzX</a> (long i, long j) const =0</td></tr>
<tr class="separator:a61bf1413f4b2e9050d83915984036bc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Virtual base class for <a class="el" href="classhelib_1_1_p_algebra_mod.html" title="The structure of Z[X]/(Phi_m(X), p)">PAlgebraMod</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a98ba2824e68366e7266717ff9f077334"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98ba2824e68366e7266717ff9f077334">&#9670;&nbsp;</a></span>~PAlgebraModBase()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual helib::PAlgebraModBase::~PAlgebraModBase </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a11f446121f3f4e99004ac5f63cd9222d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11f446121f3f4e99004ac5f63cd9222d">&#9670;&nbsp;</a></span>clone()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classhelib_1_1_p_algebra_mod_base.html">PAlgebraModBase</a>* helib::PAlgebraModBase::clone </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#a3413dd44b1f24d197c62d4747b408608">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<a id="ae9aa0cf6f8db16b0eaad3f2d4362a37c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9aa0cf6f8db16b0eaad3f2d4362a37c">&#9670;&nbsp;</a></span>getFactorsOverZZ()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const std::vector&lt;NTL::ZZX&gt;&amp; helib::PAlgebraModBase::getFactorsOverZZ </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns reference to the factorization of Phi_m(X) mod p^r, but as ZZX's. </p>

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#ac929261d8b2667e14b1c8c53e92c7f6c">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<a id="a61bf1413f4b2e9050d83915984036bc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61bf1413f4b2e9050d83915984036bc6">&#9670;&nbsp;</a></span>getMask_zzX()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespacehelib.html#a4d6002f36f1a61982fded09adf1331ca">zzX</a> helib::PAlgebraModBase::getMask_zzX </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>i</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>j</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a909cc316ce549f517857b17c172aae7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a909cc316ce549f517857b17c172aae7b">&#9670;&nbsp;</a></span>getPPowR()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual long helib::PAlgebraModBase::getPPowR </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The value p^r. </p>

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#ad6761a53cc4fe80e280958782b18f31e">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<a id="adead1be06feaba45fa7dab3a34b856a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adead1be06feaba45fa7dab3a34b856a3">&#9670;&nbsp;</a></span>getR()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual long helib::PAlgebraModBase::getR </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The value r. </p>

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#a9df1389f699003bf1579b22efb4cc546">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<a id="a8df7e36de931c1365efc1a1ec9ef0a59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8df7e36de931c1365efc1a1ec9ef0a59">&#9670;&nbsp;</a></span>getTag()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespacehelib.html#ab0181d82dc81ed4d1f8c1d950b4efd7e">PA_tag</a> helib::PAlgebraModBase::getTag </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the type tag: PA_GF2_tag or PA_zz_p_tag. </p>

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#aa2014ae146f28814d83ae8dae0546230">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<a id="a7bcc03053392d25c4a8d1c3eb36107e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bcc03053392d25c4a8d1c3eb36107e1">&#9670;&nbsp;</a></span>getZMStar()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classhelib_1_1_p_algebra.html">PAlgebra</a>&amp; helib::PAlgebraModBase::getZMStar </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns reference to underlying <a class="el" href="classhelib_1_1_p_algebra.html" title="The structure of (Z/mZ)* /(p)">PAlgebra</a> object. </p>

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#a5d2fd3234ccb5a63dd2a22d5e6dfcca0">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<a id="a87de36ed5995b6baf94954b6810b9130"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87de36ed5995b6baf94954b6810b9130">&#9670;&nbsp;</a></span>restoreContext()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void helib::PAlgebraModBase::restoreContext </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Restores the <a class="el" href="namespace_n_t_l.html">NTL</a> context for p^r. </p>

<p>Implemented in <a class="el" href="classhelib_1_1_p_algebra_mod_cx.html#afa945a421ee7efc5c29bd0e54ece935d">helib::PAlgebraModCx</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/HElib/include/helib/<a class="el" href="_p_algebra_8h_source.html">PAlgebra.h</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
        <script type="text/javascript" src="doxy-boot.js"></script>
</html>
